<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EOS.IO: eosio::table&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EOS.IO
   &#160;<span id="projectnumber">DAWN3.0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceeosio.html">eosio</a></li><li class="navelem"><a class="el" href="structeosio_1_1table.html">table</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="structeosio_1_1table-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">eosio::table&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__contractdev.html">Smart Contract API Reference</a> &raquo; <a class="el" href="group__database.html">Database API</a> &raquo; <a class="el" href="group__database_cpp.html">Database C++ API</a> &raquo; <a class="el" href="group__dualindextable.html">Dual Index Table</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="db_8hpp_source.html">db.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table_1_1primary__index.html">primary_index</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primary Index of the Table.  <a href="structeosio_1_1table_1_1primary__index.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table_1_1secondary__index.html">secondary_index</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Secondary Index of the Table.  <a href="structeosio_1_1table_1_1secondary__index.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aed60ea9a6cabdd7d471c23656a88364c"><td class="memItemLeft" align="right" valign="top">typedef PrimaryType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table.html#aed60ea9a6cabdd7d471c23656a88364c">primary</a></td></tr>
<tr class="separator:aed60ea9a6cabdd7d471c23656a88364c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1005db7b573f6d10e02bd440e5e2e995"><td class="memItemLeft" align="right" valign="top">typedef SecondaryType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table.html#a1005db7b573f6d10e02bd440e5e2e995">secondary</a></td></tr>
<tr class="separator:a1005db7b573f6d10e02bd440e5e2e995"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa21c1502397afb2cd3952e799fc391c0"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table.html#aa21c1502397afb2cd3952e799fc391c0">get</a> (const PrimaryType &amp;p, Record &amp;r, <a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> s=scope)</td></tr>
<tr class="memdesc:aa21c1502397afb2cd3952e799fc391c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetches a record from the table.  <a href="#aa21c1502397afb2cd3952e799fc391c0">More...</a><br /></td></tr>
<tr class="separator:aa21c1502397afb2cd3952e799fc391c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2e0a113e71ced0ef76d264896d121fe"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table.html#ac2e0a113e71ced0ef76d264896d121fe">store</a> (const Record &amp;r, <a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> s=scope)</td></tr>
<tr class="memdesc:ac2e0a113e71ced0ef76d264896d121fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store a record in the table.  <a href="#ac2e0a113e71ced0ef76d264896d121fe">More...</a><br /></td></tr>
<tr class="separator:ac2e0a113e71ced0ef76d264896d121fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a821eaa08caa976e17c4543c4be09713e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table.html#a821eaa08caa976e17c4543c4be09713e">update</a> (const Record &amp;r, <a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> s=scope)</td></tr>
<tr class="memdesc:a821eaa08caa976e17c4543c4be09713e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update a record in the table.  <a href="#a821eaa08caa976e17c4543c4be09713e">More...</a><br /></td></tr>
<tr class="separator:a821eaa08caa976e17c4543c4be09713e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8008464d6461f160449763dce3d4d372"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeosio_1_1table.html#a8008464d6461f160449763dce3d4d372">remove</a> (const Record &amp;r, <a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> s=scope)</td></tr>
<tr class="memdesc:a8008464d6461f160449763dce3d4d372"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a record from the table.  <a href="#a8008464d6461f160449763dce3d4d372">More...</a><br /></td></tr>
<tr class="separator:a8008464d6461f160449763dce3d4d372"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aed60ea9a6cabdd7d471c23656a88364c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed60ea9a6cabdd7d471c23656a88364c">&#9670;&nbsp;</a></span>primary</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table_n, typename Record , typename PrimaryType , typename SecondaryType  = void&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef PrimaryType <a class="el" href="structeosio_1_1table.html">eosio::table</a>&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt;::<a class="el" href="structeosio_1_1table.html#aed60ea9a6cabdd7d471c23656a88364c">primary</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a1005db7b573f6d10e02bd440e5e2e995"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1005db7b573f6d10e02bd440e5e2e995">&#9670;&nbsp;</a></span>secondary</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table_n, typename Record , typename PrimaryType , typename SecondaryType  = void&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef SecondaryType <a class="el" href="structeosio_1_1table.html">eosio::table</a>&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt;::<a class="el" href="structeosio_1_1table.html#a1005db7b573f6d10e02bd440e5e2e995">secondary</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa21c1502397afb2cd3952e799fc391c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa21c1502397afb2cd3952e799fc391c0">&#9670;&nbsp;</a></span>get()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table_n, typename Record , typename PrimaryType , typename SecondaryType  = void&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="structeosio_1_1table.html">eosio::table</a>&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt;::get </td>
          <td>(</td>
          <td class="paramtype">const PrimaryType &amp;&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a>&#160;</td>
          <td class="paramname"><em>s</em> = <code>scope</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Fetches a record from the table. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>- reference to primary key to retrieve </td></tr>
    <tr><td class="paramname">r</td><td>- reference to a record to load the value to. </td></tr>
    <tr><td class="paramname">s</td><td>- account scope. default is current scope of the class</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful read. </dd></dl>

</div>
</div>
<a id="a8008464d6461f160449763dce3d4d372"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8008464d6461f160449763dce3d4d372">&#9670;&nbsp;</a></span>remove()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table_n, typename Record , typename PrimaryType , typename SecondaryType  = void&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="structeosio_1_1table.html">eosio::table</a>&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt;::remove </td>
          <td>(</td>
          <td class="paramtype">const Record &amp;&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a>&#160;</td>
          <td class="paramname"><em>s</em> = <code>scope</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Remove a record from the table. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to a record to remove. </td></tr>
    <tr><td class="paramname">s</td><td>- account scope. default is current scope of the class</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful remove. </dd></dl>

</div>
</div>
<a id="ac2e0a113e71ced0ef76d264896d121fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2e0a113e71ced0ef76d264896d121fe">&#9670;&nbsp;</a></span>store()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table_n, typename Record , typename PrimaryType , typename SecondaryType  = void&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="structeosio_1_1table.html">eosio::table</a>&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt;::store </td>
          <td>(</td>
          <td class="paramtype">const Record &amp;&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a>&#160;</td>
          <td class="paramname"><em>s</em> = <code>scope</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Store a record in the table. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to a record to store. </td></tr>
    <tr><td class="paramname">s</td><td>- account scope. default is current scope of the class</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful store. </dd></dl>

</div>
</div>
<a id="a821eaa08caa976e17c4543c4be09713e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a821eaa08caa976e17c4543c4be09713e">&#9670;&nbsp;</a></span>update()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table_n, typename Record , typename PrimaryType , typename SecondaryType  = void&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="structeosio_1_1table.html">eosio::table</a>&lt; scope, code, table_n, Record, PrimaryType, SecondaryType &gt;::update </td>
          <td>(</td>
          <td class="paramtype">const Record &amp;&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a>&#160;</td>
          <td class="paramname"><em>s</em> = <code>scope</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Update a record in the table. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to a record to update. </td></tr>
    <tr><td class="paramname">s</td><td>- account scope. default is current scope of the class</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful update. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>contracts/eoslib/<a class="el" href="db_8hpp_source.html">db.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
